Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump MSRV to 1.57 and instruct clippy to lint against this version #1660

Merged
merged 6 commits into from
Dec 9, 2021

Conversation

mzabaluev
Copy link
Contributor

@mzabaluev mzabaluev commented Dec 8, 2021

Closes: #1659

Description

Add a clippy.toml instructing clippy to only emit lints that apply to
the MSRV declared there.

Update the rust-version fields in Cargo.toml to 1.57 which we in fact require after #1642.

Also, add a GitHub issue template with a checklist detailing all the steps to make sure they don't get omitted in future Rust version bumps.


PR author checklist:

  • Added changelog entry, using unclog.
  • Added tests: integration (for Hermes) or unit/mock tests (for modules).
  • Linked to GitHub issue.
  • Updated code comments and documentation (e.g., docs/).

Reviewer checklist:

  • Reviewed Files changed in the GitHub PR explorer.
  • Manually tested (in case integration/unit/mock tests are absent).

Currently at 1.57.0 due to some recent lint-driven changes requiring the
newest stable Rust.
@mzabaluev mzabaluev changed the title Mikhail/msrv Define the minimal supported Rust version Dec 8, 2021
@mzabaluev mzabaluev added the O: code-hygiene Objective: cause to improve code hygiene label Dec 8, 2021
@mzabaluev mzabaluev changed the title Define the minimal supported Rust version Bump MSRV to 1.57 and instruct clippy to lint against this version Dec 8, 2021
@mzabaluev mzabaluev marked this pull request as ready for review December 8, 2021 17:06
As the process of updating to a new Rust version, especially when
bumping the MSRV, requires many steps and some of them tend to
get forgotten, make an issue template with a checklist of
all the steps.
@mzabaluev mzabaluev added the I: infrastructure Internal: related to Infrastructure (testing, deployment, etc) label Dec 8, 2021
Copy link
Member

@romac romac left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding an issue template is a great idea! Thanks @mzabaluev :)

@romac romac merged commit df027e5 into master Dec 9, 2021
@romac romac deleted the mikhail/msrv branch December 9, 2021 09:21
- [ ] Update the `rust-version` fields in all `Cargo.toml` files.
- [ ] Update the `msrv` field in `clippy.toml` and fix all lints reported by
`cargo clippy --all-features`.
- [ ] Update the MSRV shields in README files:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💯

hu55a1n1 pushed a commit to hu55a1n1/hermes that referenced this pull request Sep 13, 2022
…nformalsystems#1660)

* Bump rust-version to 1.57 in Cargo.toml

* Add clippy.toml with the MSRV configuration

Currently at 1.57.0 due to some recent lint-driven changes requiring the
newest stable Rust.

* Updated all mentions of MSRV to 1.57

Also in the guide.

* Changelog entry for informalsystems#1660

* Add an issue template with Rust update checklist

As the process of updating to a new Rust version, especially when
bumping the MSRV, requires many steps and some of them tend to
get forgotten, make an issue template with a checklist of
all the steps.

* Advise on fixing lints in rust-update template
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
I: infrastructure Internal: related to Infrastructure (testing, deployment, etc) O: code-hygiene Objective: cause to improve code hygiene
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Define the minimal supported Rust version
3 participants